home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat1 / newhelp.z / newhelp
Text File  |  1997-04-03  |  4KB  |  133 lines

  1.  
  2.  
  3.  
  4. NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))                                                          NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      nnnneeeewwwwhhhheeeellllpppp - generate a performance metrics help database
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ////uuuussssrrrr////ppppccccpppp////bbbbiiiinnnn////nnnneeeewwwwhhhheeeellllpppp [----VVVV] [----nnnn _n_a_m_e_s_p_a_c_e] [----oooo _o_u_t_p_u_t_f_i_l_e] [_f_i_l_e ...]
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      nnnneeeewwwwhhhheeeellllpppp generates nnnnddddbbbbmmmm(3B) database files for one or more source files of
  16.      Performance Co-Pilot help text.
  17.  
  18.      Normally nnnneeeewwwwhhhheeeellllpppp operates on the default Performance Metrics Namespace
  19.      (PMNS), however if the ----nnnn option is specified an alternative namespace is
  20.      loaded from the file _n_a_m_e_s_p_a_c_e.
  21.  
  22.      When there is only one input file, the base name of the new database is
  23.      derived from the name of the input _f_i_l_e, otherwise the ----oooo flag must be
  24.      given to explicitly name the database.  If no input files are supplied,
  25.      nnnneeeewwwwhhhheeeellllpppp reads from the standard input stream, in which case the ----oooo flag
  26.      must be given.
  27.  
  28.      If the output file name is determined to be ffffoooooooo, nnnneeeewwwwhhhheeeellllpppp will create
  29.      ffffoooooooo....ddddiiiirrrr and ffffoooooooo....ppppaaaagggg.
  30.  
  31.      The ----VVVV flag causes verbose messages to be printed whilst nnnneeeewwwwhhhheeeellllpppp is
  32.      parsing it's input.
  33.  
  34.      The first line of each entry in a help source file consists of an ``@''
  35.      character beginning the line followed by a space and then the performance
  36.      metric name and a one line description of the metric.  Following lines
  37.      (up to the next line beginning with ``@'' or end of file) may contain a
  38.      verbose help description.  E.g.
  39.  
  40.           #
  41.           # This is an example of newhelp's input syntax
  42.           #
  43.           @ irix.kernel.all.cpu.idle CPU idle time
  44.           A cumulative count of the number of milliseconds
  45.           of CPU idle time, summed over all processors.
  46.  
  47.      Lines beginning with ``#'' are ignored, as are blank lines in the file
  48.      before the first ``@''.  The verbose help text is optional.
  49.  
  50.      As a special case, a ``metric'' name of the form _N_N_N._M_M (for numeric _N_N_N
  51.      and _M_M) is interpreted as an instance domain identification, and the text
  52.      describes the instance domain.
  53.  
  54. FFFFIIIILLLLEEEESSSS
  55.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmnnnnssss////*         default PMNS specification files
  56.      ////uuuussssrrrr////ppppccccpppp////hhhheeeellllpppp////*         installation directory containing PCP help
  57.                              nnnnddddbbbbmmmm(1) files
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))                                                          NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))
  71.  
  72.  
  73.  
  74. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  75.      cccchhhhkkkkhhhheeeellllpppp(1), ppppmmmmcccchhhhaaaarrrrtttt(1), PPPPMMMMAAAAPPPPIIII(3), ppppmmmmLLLLooooooookkkkuuuuppppIIIInnnnDDDDoooommmmTTTTeeeexxxxtttt(3), ppppmmmmLLLLooooooookkkkuuuuppppTTTTeeeexxxxtttt(3)
  76.      and nnnnddddbbbbmmmm(3B).
  77.  
  78. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.